/**
 * 
 * Copyright (C) 2011 Cody Stoutenburg . All rights reserved.
 *
 *       This program is free software; you can redistribute it and/or
 *       modify it under the terms of the GNU Lesser General Public License
 *       as published by the Free Software Foundation; either version 2.1
 *       of the License, or (at your option) any later version.
 *
 *       This program is distributed in the hope that it will be useful,
 *       but WITHOUT ANY WARRANTY; without even the implied warranty of
 *       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *       GNU Lesser General Public License for more details.
 *
 *       You should have received a copy of the GNU Lesser General Public License
 *       along with this program; if not, write to the Free Software
 *       Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. 
 * 
 */
package ca.usherbrooke.behaviour;

import ca.usherbrooke.agent.SimpleAutonomousAgent;
import ca.usherbrooke.agent.controller.shared.IBehaviourOnWorldChanged;
import ca.usherbrooke.goal.BasicGoal;

/**
 * @author Cody Stoutenburg
 * 
 */
public abstract class AutonomousBehaviour extends
		IBehaviourOnWorldChanged<SimpleAutonomousAgent> {

	private static final long serialVersionUID = 1L;

	/**
	 * @param a
	 */
	public AutonomousBehaviour(SimpleAutonomousAgent a) {
		super(a);
	}

	@Override
	public final void action() {
		BasicGoal current = getAgent().getSelectedGoal();
		if (current == null) {
			// if no current goal select one
			getAgent().setSelectedGoal(selectGoal());
		} else if (current != null && current.isTerminated()) {
			// the goal is solve or is remove
			if (current.isSolve()) {
				onGoalSolve();
			} else {
				onGoalFail();
			}
			onGoalTerminated();
			getAgent().setSelectedGoal(null);
		} else {
			tryToSolveGoal();
		}
	}

	@Override
	public boolean done() {
		return false;
	}

	protected abstract Long selectGoal();

	protected abstract void onGoalSolve();

	protected abstract void onGoalFail();

	protected abstract void onGoalTerminated();

	protected abstract void tryToSolveGoal();
}
